#todo 

## Описание

##### Основные элементы **README**:
* Название файла пишется с большой буквы;
* Имя проекта внятное и описательное;
* Однострочное описание для понимания сути проекта;
* Чёткий и исполнимый пример использования (либо явная ссылка на файл с примером);
* Описание API - для поставляемого модуля, либо обширная документация API;
* Инструкции по установке и запуску;
* Лицензия.

##### Дополнительные элементы:
* **Background**, если в этом есть необходимость;
* Использование ссылок на другие ресурсы;
* Потенциально незнакомые термины должны быть связаны с информативными источниками;
* Указание предостережений и ограничений с самого начала.

## Идеи README
* Для создателей и потребителей - создателю потребуется чтобы спустя какое-то время продолжить работу с проектом, а потребителю, чтобы понять интересен ли проект для него;
* **README** - единственный способ презентовать проект и идеально, если после прочтения не потребуется заглядывать в код проекта;
* Краткость;
* Отделение документированного интерфейса от его реализации позволит дорабатывать проект сохраняя интерфейс неизменным;
* **README** как когнитивная воронка, проходя которую пользователь понимает необходимо ли ему использовать проект;
* Экономия времени людей - описание "не продажное", а максимально объективное;

## Ссылки
Перевод статьи [Art of README](https://habr.com/ru/articles/810537/), [оригинал](https://github.com/hackergrrl/art-of-readme) статьи.

Другие ресурсы:
* Формат общего Readme [standard-readme](https://github.com/richardlitt/standard-readme)
* Набор рекомендаций [common-readme](https://github.com/hackergrrl/common-readme)
* [Software Release Practice](https://tldp.org/HOWTO/Software-Release-Practice-HOWTO/distpractice.html#readme)
* [GNU Releases](https://www.gnu.org/prep/standards/html_node/Releases.html#index-README-file)

Образцы:
- [https://github.com/hackergrrl/ice-box](https://github.com/hackergrrl/ice-box) 
- [https://github.com/substack/quote-stream](https://github.com/substack/quote-stream)
- [https://github.com/feross/bittorrent-dht](https://github.com/feross/bittorrent-dht)
- [https://github.com/mikolalysenko/box-intersect](https://github.com/mikolalysenko/box-intersect)
- [https://github.com/freeman-lab/pixel-grid](https://github.com/freeman-lab/pixel-grid)
- [https://github.com/mafintosh/torrent-stream](https://github.com/mafintosh/torrent-stream)
- [https://github.com/pull-stream/pull-stream](https://github.com/pull-stream/pull-stream)
- [https://github.com/substack/tape](https://github.com/substack/tape)
- [https://github.com/yoshuawuyts/vmd](https://github.com/yoshuawuyts/vmd)
- [https://github.com/aimclub/open-source-ops](https://github.com/aimclub/open-source-ops/blob/master/templates/template_README.md)